Pensez à utiliser des extraits de code

Lors de la rédaction de l'aide d'une application, il arrive très souvent que cette dernière ne soit pas encore finalisée.

C'est un problème pour le rédacteur, car l'aide est développée en même temps que l'application. Ainsi, le rédacteur de l'aide peut avoir fait des captures d'écran ne correspondant plus à la version finale de l'application. Lorsque la fin du développement de l'application approche, le rédacteur doit refaire ces captures.

Bien que ce processus ne soit pas très compliqué, il reste fastidieux de vérifier que chaque rubrique contenant une image utilise bien la dernière version de celle-ci. Tant que les dimensions de l'image ne varient pas, il suffit d'enregistrer la nouvelle image au même emplacement que l'ancienne en utilisant le même nom.

Mais que se passe-t-il si les dimensions varient ?

C'est dans ce cas que les extraits de code peuvent se révéler utiles. Vous économiserez du temps et de l'énergie en créant l'extrait de code d'une image afin de l'insérer dans les rubriques à la place de celle-ci. Cela permet de ne modifier l'image qu'à un seul endroit. Une fois la modification apportée, toutes les rubriques utilisant l'extrait de code sont mises à jour. Il n'est plus nécessaire de rechercher toutes les rubriques utilisant l'image.

Etape

Action

Actions

1

Affichage du conteneur Extrait de code

Cliquez sur Affichage > Conteneurs > Extrait de code.

2

Création d'un extrait de code

Cliquez sur Fichier > Nouveau > Extrait de code.

Le conteneur Modification du document affiche le nouvel extrait de code.

3

Insertion de l'image dans l'extrait de code

Sélectionnez le texte de l'extrait de code du conteneur Modification du document et remplacez-le par la capture d'écran de l'application.

4

Insertion de l'extrait de code dans des rubriques

Modifiez la rubrique contenant la capture d'écran de l'application

Cliquez sur l'extrait de code et déplacez-le du conteneur Extrait de code vers la rubrique.

Consultez la rubrique The_WidgetMax_Information_Screen.htm du dossier Screen_Level pour voir un exemple de mise en œuvre de cette technique.